package com.gitee.helioz.openai.api.dto.edits;

import com.gitee.helioz.openai.api.dto.UsageDTO;
import lombok.Data;

import java.util.List;

/**
 * 〈文本编辑响应〉
 *
 * @author <a href="https://gitee.com/helioz">Morning Starr</a>
 */
@Data
public class EditResponse {
    /**
     * 返回结果的对象类型，该值为固定的字符串 "edit"。
     */
    private String object;
    /**
     * 编辑结果的生成时间，以 Unix 时间戳格式表示。
     */
    private Long created;
    /**
     * 包含了编辑结果的数组，可能包含多个编辑选择（choices）
     */
    private List<Choice> choices;
    /**
     * Usage 字段包含了 API 调用使用情况统计信息，可以帮助用户了解每次 API 调用使用了多少令牌，从而控制 API 使用量并进行计费或限制。
     */
    private UsageDTO usage;

    @Data
    public static class Choice {
        /**
         * 生成的编辑文本
         */
        private String text;
        /**
         * 选择的索引，通常为 0，表示第一个选择
         */
        private Integer index;
    }
}
